Web Service BIG API
MethodchangePassword
Opis
Operacja zmiany hasła
Operacja umożliwia zmianę hasła użytkownika.
Change password
Żądanie (changePasswordRequest)

Komunikat żądania jest typu changePasswordRequest.

Element newPassword Element clientId Element requestDateTime Element requestId Sequence Element changePasswordRequest

Przegląd

ChangePasswordRequest
Żądanie zmiany hasła
Change password request
Sequence
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
clientId xs:string
Identyfikator subskrybenta
Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.
Subscriber ID
A unique ID assigned by BIG InfoMonitor to any subscriber within the system.
newPassword xs:string
Nowe hało
Hasło, które będzie obowiązywać po zmianie
New password
Password that will be valid after the change
Odpowiedź (changePasswordResponse)

Komunikat odpowiedzi jest typu changePasswordResponse.

Element success Element error Choice Element user Element requestDateTime Element requestId Element responseDateTime Element responseId Sequence Element changePasswordResponse

Przegląd

ChangePasswordResponse
Rezultat przetworzenia żądania zmiany hasła
Change password response
Sequence
responseId Typ prosty messageId
Identyfikator odpowiedzi
Ciąg znaków jednoznacznie identyfikujący odpowiedź z systemu SIBIG. Nadawany przez BIG IM.
Response id
String uniquely identifying the response. Given by the BIG IM.
responseDateTime xs:dateTime
Data i czas przesłania odpowiedzi
Response date and time
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania, z którym związana jest ta odpowiedź. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
user xs:string
Identyfikator użytkownika
Identyfikator użytkownika przesyłającego żądanie w rejestrze BIG IM.
Username
ID of the SIBIG user submitting the request.
Choice
error Typ prosty changePasswordErrorEnum
Błąd
Błąd zmiany hasła
Error
Change password error
Błąd zmiany hasła
success xs:anyType
Sukces
Hasło zmienione
Success
Password changed
Wyjątki
WyjątekOpis
Wyjątek powoduje zwrócenie komunikatu typu http://api.big.pl/bigApi/v1:processingError.  
Wyjątek powoduje zwrócenie komunikatu typu http://api.big.pl/bigApi/v1:signInError.  
Wyjątek powoduje zwrócenie komunikatu typu http://api.big.pl/bigApi/v1:authorisationError.  
Zobacz także